You are here:

Create a Discover report

{ createDiscover }

Creates a new Discover report item for a given Semantic Data model with model selections and visualization settings.

Method

/API3/analytics/createDiscover

API Section: /API3/analytics

API Version: 3.0

From Release: 2023.0

Can be used by admin users only

REST API and Client SDK libraries. REST APIs via POST actions only.

Input Parameters

Name

discoverData

Object Type

DiscoverData

Description

Metadata details of the Discover item

Output Response

Successful Result Code

200

Response Type

string

Description of Response Type

Returns the created discover ID

Code Snippets

JavaScript

Curl

Java

Python

PHP

curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/text,application/xml" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/analytics/createDiscover" \
 -d '{
  "itemName" : "itemName",
  "visuals" : {
    "grid" : {
      "filter" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "GridFilterValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "GridFilterHierarchyChip"
          },
          "inheritanceType" : "GridFilterChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "GridFilterValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "GridFilterHierarchyChip"
          },
          "inheritanceType" : "GridFilterChip"
        } ],
        "inheritanceType" : "GridFilterDropZone"
      },
      "indicator" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "GridIndicatorMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "GridIndicatorMeasureChip"
        } ],
        "inheritanceType" : "GridIndicatorDropZone"
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "gridColorOption" : "Background",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "GridColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "gridColorOption" : "Background",
            "inheritanceType" : "GridColorHierarchyChip"
          },
          "inheritanceType" : "GridColorChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "gridColorOption" : "Background",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "GridColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "gridColorOption" : "Background",
            "inheritanceType" : "GridColorHierarchyChip"
          },
          "inheritanceType" : "GridColorChip"
        } ],
        "inheritanceType" : "GridColorDropZone"
      },
      "size" : {
        "dropZoneChips" : [ {
          "gridSizeOption" : "FontSize",
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "GridSizeMeasureChip"
        }, {
          "gridSizeOption" : "FontSize",
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "GridSizeMeasureChip"
        } ],
        "inheritanceType" : "GridSizeDropZone"
      },
      "values" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "GridValuesMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "GridValuesMeasureChip"
        } ],
        "inheritanceType" : "GridValuesDropZone"
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridTooltipHierarchyChip"
          },
          "inheritanceType" : "GridTooltipChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridTooltipHierarchyChip"
          },
          "inheritanceType" : "GridTooltipChip"
        } ],
        "inheritanceType" : "GridTooltipDropZone"
      },
      "rows" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridRowsValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridRowsHierarchyChip"
          },
          "inheritanceType" : "GridRowsChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridRowsValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridRowsHierarchyChip"
          },
          "inheritanceType" : "GridRowsChip"
        } ],
        "inheritanceType" : "GridRowsDropZone"
      },
      "cols" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridColsValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridColsHierarchyChip"
          },
          "inheritanceType" : "GridColsChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridColsValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "GridColsHierarchyChip"
          },
          "inheritanceType" : "GridColsChip"
        } ],
        "inheritanceType" : "GridColsDropZone"
      },
      "inheritanceType" : "GridVisual"
    },
    "segment" : {
      "filter" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "SegmentFilterValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "SegmentFilterHierarchyChip"
          },
          "inheritanceType" : "SegmentFilterChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "SegmentFilterValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "SegmentFilterHierarchyChip"
          },
          "inheritanceType" : "SegmentFilterChip"
        } ],
        "inheritanceType" : "SegmentFilterDropZone"
      },
      "visualType" : "PieChart",
      "trellisHorizontal" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTrellisHorizontalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTrellisHorizontalHierarchyChip"
          },
          "inheritanceType" : "SegmentTrellisHorizontalChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTrellisHorizontalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTrellisHorizontalHierarchyChip"
          },
          "inheritanceType" : "SegmentTrellisHorizontalChip"
        } ],
        "inheritanceType" : "SegmentTrellisHorizontalDropZone"
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "SegmentColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentColorHierarchyChip"
          },
          "inheritanceType" : "SegmentColorChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "SegmentColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentColorHierarchyChip"
          },
          "inheritanceType" : "SegmentColorChip"
        } ],
        "inheritanceType" : "SegmentColorDropZone"
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "SegmentSizeMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "SegmentSizeMeasureChip"
        } ],
        "inheritanceType" : "SegmentSizeDropZone"
      },
      "motion" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "SegmentMotionHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "SegmentMotionHierarchyChip"
        } ],
        "inheritanceType" : "SegmentMotionDropZone"
      },
      "trellisVertical" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTrellisVerticalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTrellisVerticalHierarchyChip"
          },
          "inheritanceType" : "SegmentTrellisVerticalChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTrellisVerticalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTrellisVerticalHierarchyChip"
          },
          "inheritanceType" : "SegmentTrellisVerticalChip"
        } ],
        "inheritanceType" : "SegmentTrellisVerticalDropZone"
      },
      "values" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "SegmentValuesMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "SegmentValuesMeasureChip"
        } ],
        "inheritanceType" : "SegmentValuesDropZone"
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTooltipHierarchyChip"
          },
          "inheritanceType" : "SegmentTooltipChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentTooltipHierarchyChip"
          },
          "inheritanceType" : "SegmentTooltipChip"
        } ],
        "inheritanceType" : "SegmentTooltipDropZone"
      },
      "details" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "SegmentDetailsHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "SegmentDetailsHierarchyChip"
        } ],
        "inheritanceType" : "SegmentDetailsDropZone"
      },
      "labels" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentLabelsMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentLabelsHierarchyChip"
          },
          "inheritanceType" : "SegmentLabelsChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentLabelsMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "SegmentLabelsHierarchyChip"
          },
          "inheritanceType" : "SegmentLabelsChip"
        } ],
        "inheritanceType" : "SegmentLabelsDropZone"
      },
      "inheritanceType" : "SegmentVisual"
    },
    "scatter" : {
      "trellisHorizontal" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTrellisHorizontalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTrellisHorizontalHierarchyChip"
          },
          "inheritanceType" : "ScatterTrellisHorizontalChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTrellisHorizontalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTrellisHorizontalHierarchyChip"
          },
          "inheritanceType" : "ScatterTrellisHorizontalChip"
        } ],
        "inheritanceType" : "ScatterTrellisHorizontalDropZone"
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "ScatterColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterColorHierarchyChip"
          },
          "inheritanceType" : "ScatterColorChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "ScatterColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterColorHierarchyChip"
          },
          "inheritanceType" : "ScatterColorChip"
        } ],
        "inheritanceType" : "ScatterColorDropZone"
      },
      "motion" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "ScatterMotionHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "ScatterMotionHierarchyChip"
        } ],
        "inheritanceType" : "ScatterMotionDropZone"
      },
      "shape" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterShapeMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterShapeHierarchyChip"
          },
          "inheritanceType" : "ScatterShapeChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterShapeMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterShapeHierarchyChip"
          },
          "inheritanceType" : "ScatterShapeChip"
        } ],
        "inheritanceType" : "ScatterShapeDropZone"
      },
      "trellisVertical" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTrellisVerticalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTrellisVerticalHierarchyChip"
          },
          "inheritanceType" : "ScatterTrellisVerticalChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTrellisVerticalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTrellisVerticalHierarchyChip"
          },
          "inheritanceType" : "ScatterTrellisVerticalChip"
        } ],
        "inheritanceType" : "ScatterTrellisVerticalDropZone"
      },
      "yValues" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "ScatterYValuesMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "ScatterYValuesMeasureChip"
        } ],
        "inheritanceType" : "ScatterYValuesDropZone"
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTooltipHierarchyChip"
          },
          "inheritanceType" : "ScatterTooltipChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterTooltipHierarchyChip"
          },
          "inheritanceType" : "ScatterTooltipChip"
        } ],
        "inheritanceType" : "ScatterTooltipDropZone"
      },
      "xValues" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "ScatterXValuesMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "ScatterXValuesMeasureChip"
        } ],
        "inheritanceType" : "ScatterXValuesDropZone"
      },
      "labels" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterLabelsMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterLabelsHierarchyChip"
          },
          "inheritanceType" : "ScatterLabelsChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterLabelsMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "ScatterLabelsHierarchyChip"
          },
          "inheritanceType" : "ScatterLabelsChip"
        } ],
        "inheritanceType" : "ScatterLabelsDropZone"
      },
      "filter" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "ScatterFilterValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "ScatterFilterHierarchyChip"
          },
          "inheritanceType" : "ScatterFilterChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "ScatterFilterValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "ScatterFilterHierarchyChip"
          },
          "inheritanceType" : "ScatterFilterChip"
        } ],
        "inheritanceType" : "ScatterFilterDropZone"
      },
      "visualType" : "ScatterChart",
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "ScatterSizeMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "ScatterSizeMeasureChip"
        } ],
        "inheritanceType" : "ScatterSizeDropZone"
      },
      "details" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "ScatterDetailsHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "ScatterDetailsHierarchyChip"
        } ],
        "inheritanceType" : "ScatterDetailsDropZone"
      },
      "inheritanceType" : "ScatterVisual"
    },
    "tabular" : {
      "filter" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "filterType" : "DropDownSingleSelect",
          "inheritanceType" : "TabularFilterHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "filterType" : "DropDownSingleSelect",
          "inheritanceType" : "TabularFilterHierarchyChip"
        } ],
        "inheritanceType" : "TabularFilterDropZone"
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "TabularColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularColorHierarchyChip"
          },
          "inheritanceType" : "TabularColorChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "TabularColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularColorHierarchyChip"
          },
          "inheritanceType" : "TabularColorChip"
        } ],
        "inheritanceType" : "TabularColorDropZone"
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "TabularSizeMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "TabularSizeMeasureChip"
        } ],
        "inheritanceType" : "TabularSizeDropZone"
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularTooltipHierarchyChip"
          },
          "inheritanceType" : "TabularTooltipChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularTooltipHierarchyChip"
          },
          "inheritanceType" : "TabularTooltipChip"
        } ],
        "inheritanceType" : "TabularTooltipDropZone"
      },
      "cols" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularColsMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularColsHierarchyChip"
          },
          "inheritanceType" : "TabularColsChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularColsMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "TabularColsHierarchyChip"
          },
          "inheritanceType" : "TabularColsChip"
        } ],
        "inheritanceType" : "TabularColsDropZone"
      },
      "inheritanceType" : "TabularVisual"
    },
    "map" : {
      "filter" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "filterType" : "DropDownSingleSelect",
          "inheritanceType" : "MapFilterHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "filterType" : "DropDownSingleSelect",
          "inheritanceType" : "MapFilterHierarchyChip"
        } ],
        "inheritanceType" : "MapFilterDropZone"
      },
      "visualType" : "Map",
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "MapColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "MapColorHierarchyChip"
          },
          "inheritanceType" : "MapColorChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "MapColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "MapColorHierarchyChip"
          },
          "inheritanceType" : "MapColorChip"
        } ],
        "inheritanceType" : "MapColorDropZone"
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "MapSizeMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "MapSizeMeasureChip"
        } ],
        "inheritanceType" : "MapSizeDropZone"
      },
      "motion" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "MapMotionHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "MapMotionHierarchyChip"
        } ],
        "inheritanceType" : "MapMotionDropZone"
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "MapTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "MapTooltipHierarchyChip"
          },
          "inheritanceType" : "MapTooltipChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "MapTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "MapTooltipHierarchyChip"
          },
          "inheritanceType" : "MapTooltipChip"
        } ],
        "inheritanceType" : "MapTooltipDropZone"
      },
      "location" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mapOptions" : "Latitude",
            "inheritanceType" : "MapLocationMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "MapLocationHierarchyChip"
          },
          "inheritanceType" : "MapLocationChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mapOptions" : "Latitude",
            "inheritanceType" : "MapLocationMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "MapLocationHierarchyChip"
          },
          "inheritanceType" : "MapLocationChip"
        } ],
        "inheritanceType" : "MapLocationDropZone"
      },
      "details" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "MapDetailsHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "MapDetailsHierarchyChip"
        } ],
        "inheritanceType" : "MapDetailsDropZone"
      },
      "inheritanceType" : "MapVisual"
    },
    "cartesian" : {
      "trellisHorizontal" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTrellisHorizontalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTrellisHorizontalHierarchyChip"
          },
          "inheritanceType" : "CartesianTrellisHorizontalChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTrellisHorizontalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTrellisHorizontalHierarchyChip"
          },
          "inheritanceType" : "CartesianTrellisHorizontalChip"
        } ],
        "inheritanceType" : "CartesianTrellisHorizontalDropZone"
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "CartesianColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianColorHierarchyChip"
          },
          "inheritanceType" : "CartesianColorChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "mathFunction" : "Linear",
            "targetMeasure" : "targetMeasure",
            "inheritanceType" : "CartesianColorMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianColorHierarchyChip"
          },
          "inheritanceType" : "CartesianColorChip"
        } ],
        "inheritanceType" : "CartesianColorDropZone"
      },
      "motion" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "CartesianMotionHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "CartesianMotionHierarchyChip"
        } ],
        "inheritanceType" : "CartesianMotionDropZone"
      },
      "shape" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianShapeMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianShapeHierarchyChip"
          },
          "inheritanceType" : "CartesianShapeChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianShapeMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianShapeHierarchyChip"
          },
          "inheritanceType" : "CartesianShapeChip"
        } ],
        "inheritanceType" : "CartesianShapeDropZone"
      },
      "trellisVertical" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTrellisVerticalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTrellisVerticalHierarchyChip"
          },
          "inheritanceType" : "CartesianTrellisVerticalChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTrellisVerticalValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTrellisVerticalHierarchyChip"
          },
          "inheritanceType" : "CartesianTrellisVerticalChip"
        } ],
        "inheritanceType" : "CartesianTrellisVerticalDropZone"
      },
      "values" : {
        "dropZoneChips" : [ {
          "cartesianValuesOption" : "PrimaryAxis",
          "uniqueName" : "uniqueName",
          "chartType" : {
            "barVisualType" : "BarChart",
            "stackedBarVisualType" : "StackedBarChart",
            "lineVisualType" : "ColumnChart",
            "stackedColumnVisualType" : "StackedColumnChart",
            "columnVisualType" : "ColumnChart"
          },
          "targetMeasure" : "targetMeasure",
          "inheritanceType" : "CartesianValuesMeasureChip"
        }, {
          "cartesianValuesOption" : "PrimaryAxis",
          "uniqueName" : "uniqueName",
          "chartType" : {
            "barVisualType" : "BarChart",
            "stackedBarVisualType" : "StackedBarChart",
            "lineVisualType" : "ColumnChart",
            "stackedColumnVisualType" : "StackedColumnChart",
            "columnVisualType" : "ColumnChart"
          },
          "targetMeasure" : "targetMeasure",
          "inheritanceType" : "CartesianValuesMeasureChip"
        } ],
        "inheritanceType" : "CartesianValuesDropZone"
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTooltipHierarchyChip"
          },
          "inheritanceType" : "CartesianTooltipChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTooltipMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianTooltipHierarchyChip"
          },
          "inheritanceType" : "CartesianTooltipChip"
        } ],
        "inheritanceType" : "CartesianTooltipDropZone"
      },
      "labels" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianLabelsMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianLabelsHierarchyChip"
          },
          "inheritanceType" : "CartesianLabelsChip"
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianLabelsMeasureChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "inheritanceType" : "CartesianLabelsHierarchyChip"
          },
          "inheritanceType" : "CartesianLabelsChip"
        } ],
        "inheritanceType" : "CartesianLabelsDropZone"
      },
      "filter" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "CartesianFilterValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "CartesianFilterHierarchyChip"
          },
          "inheritanceType" : "CartesianFilterChip"
        }, {
          "values" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "CartesianFilterValuesChip"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName",
            "filterType" : "DropDownSingleSelect",
            "inheritanceType" : "CartesianFilterHierarchyChip"
          },
          "inheritanceType" : "CartesianFilterChip"
        } ],
        "inheritanceType" : "CartesianFilterDropZone"
      },
      "visualType" : "ColumnChart",
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "CartesianSizeMeasureChip"
        }, {
          "uniqueName" : "uniqueName",
          "sizeMathFunction" : "Linear",
          "inheritanceType" : "CartesianSizeMeasureChip"
        } ],
        "inheritanceType" : "CartesianSizeDropZone"
      },
      "categories" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "CartesianCategoriesHierarchyChip"
        }, {
          "uniqueName" : "uniqueName",
          "inheritanceType" : "CartesianCategoriesHierarchyChip"
        } ],
        "inheritanceType" : "CartesianCategoriesDropZone"
      },
      "inheritanceType" : "CartesianVisual"
    },
    "inheritanceType" : "Visuals"
  },
  "queryOptions" : {
    "showEmpties" : true,
    "cacheMode" : "MODEL_DEFAULT",
    "totalsSettings" : {
      "colTotalSettings" : {
        "position" : "END",
        "type" : "NONE"
      },
      "rowTotalSettings" : {
        "position" : "END",
        "type" : "NONE"
      }
    },
    "executionSettings" : {
      "Optimized" : true,
      "SubQueryMode" : true
    }
  },
  "description" : "description",
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "themeId" : "themeId",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "hierarchyElementSections" : [ {
    "all" : true,
    "selectionsList" : [ {
      "selectionType" : "ELEMENT",
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    }, {
      "selectionType" : "ELEMENT",
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    } ],
    "uniqueName" : "uniqueName"
  }, {
    "all" : true,
    "selectionsList" : [ {
      "selectionType" : "ELEMENT",
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    }, {
      "selectionType" : "ELEMENT",
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    } ],
    "uniqueName" : "uniqueName"
  } ],
  "folderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "elementSelections" : [ {
    "all" : true,
    "selectionsList" : [ {
      "selectionType" : "ELEMENT",
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    }, {
      "selectionType" : "ELEMENT",
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    } ],
    "uniqueName" : "uniqueName"
  }, {
    "all" : true,
    "selectionsList" : [ {
      "selectionType" : "ELEMENT",
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    }, {
      "selectionType" : "ELEMENT",
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    } ],
    "uniqueName" : "uniqueName"
  } ],
  "tags" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "inheritanceType" : "DiscoverData"
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AnalyticsServiceApi;

import java.util.*;

public class AnalyticsServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AnalyticsServiceApi apiInstance = new AnalyticsServiceApi();
        // Initialize the discoverData parameter object for the call
        DiscoverData discoverData = ; // DiscoverData | 

        try {
            UUID result = apiInstance.createDiscover(discoverData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsServiceApi#createDiscover");
            e.printStackTrace();
        }
    }
}

const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;

// Configure API key authorization: paToken
const paToken = defaultClient.authentications['paToken'];
paToken.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.apiKeyPrefix['paToken'] = "Token";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AnalyticsServiceApi("http://Your.Server.URL")
const discoverData = ; // {DiscoverData} 

const callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDiscover(discoverData, callback);

using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class createDiscoverExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new AnalyticsServiceApi();
        // Initialize the discoverData parameter object for the call
        var discoverData = new DiscoverData(); // DiscoverData | 

        try {
            // Creates a new Discover report item for a given Semantic Data model with model selections and visualization settings.
            UUID result = apiInstance.createDiscover(discoverData);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AnalyticsServiceApi.createDiscover: " + e.Message );
        }
    }
}

import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from pprint import pprint


# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# api_config.api_key_prefix['paToken'] = 'Bearer'

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = com.pyramidanalytics.AnalyticsServiceApi(api_client)
    # Initialize the discoverData parameter object for the call
    discoverData =  # DiscoverData | 

    try:
        # Creates a new Discover report item for a given Semantic Data model with model selections and visualization settings.
        api_response = api_instance.create_discover(discoverData)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnalyticsServiceApi->createDiscover: %s\n" % e)

<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnalyticsServiceApi();
$discoverData = ; // DiscoverData | 

try {
    $result = $api_instance->createDiscover($discoverData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsServiceApi->createDiscover: ', $e->getMessage(), PHP_EOL;
}
?>

Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.

Feedback

Couldn't find what I was looking for

Help was confusing, unclear or incomplete

Instructions didn't work